Debugging/de

Voraussetzungen:

• Softwarepaket gdb installiert
• ein Fehlersuch-Build von FreeCAD (zur Zeit nur verfügbar unter Für einen Fehlersuch Bau)
• ein FreeCAD-Modell, das einen Absturz verursacht

Schritte: Gib in deinem Terminalfenster folgendes ein:

Finde das FreeCAD-Programm auf deinem System:

$ whereis freecad
freecad: /usr/local/freecad <--- for example

$ cd /usr/local/freecad/bin
$ gdb FreeCAD

GNUdebugger gibt einige Initialisierungsinformationen aus. Die (gdb) zeigt, dass der GNUDebugger im Terminal läuft, das nun eingegeben wird:

(gdb) handle SIG33 noprint nostop
(gdb) run

FreeCAD wird nun gestartet. Führe die Schritte aus, die dazu führen, dass FreeCAD abstürzt oder einfriert, und gib dann in das Terminalfenster ein:

(gdb) bt

Dies führt zu einer langen Auflistung dessen, was das Programm beim Absturz oder Einfrieren genau getan hat. Füge dies deinem Problembericht bei.

(gdb) bt full

Drucke auch die Werte der lokalen Variablen. Dies kann mit einer Zahl kombiniert werden, um die Anzahl der angezeigten Rahmen zu begrenzen.

Voraussetzungen:

• Softwarepaket lldb installiert
• ein Fehlerdiagnose build von FreeCAD
• ein FreeCAD Modell, dass den Absturz verursacht

Schritte: Gib das Folgende in Dein Terminalfenster ein:

$ cd FreeCAD/bin
$ lldb FreeCAD

LLDB gibt einige Initialisierungsinformationen aus. Die (lldb) zeigt an, dass das Fehlerdiagnoseprogramm im Terminal läuft, jetzt eingegeben:

(lldb) run

FreeCAD wird nun gestartet. Führe die Schritte aus, die dazu führen, dass FreeCAD abstürzt oder einfriert, und gib dann in das Terminalfenster ein:

(lldb) bt

Dies führt zu einer längeren Auflistung dessen, was das Programm genau getan hat, als es abgestürzt ist oder eingefroren ist. Füge dies deinem Problembericht bei.

Hier ist ein Beispiel für die Verwendung von Winpdb in FreeCAD:

Wir benötigen das Python-Fehlerdiagnoseprogramm Winpdb. Wenn es nicht installiert ist, lässt sich das auf Ubuntu/Debian wie folgt tun:

sudo apt-get install winpdb

Jetzt werden wir das Fehlerdiagnoseprogramm einrichten.

1. Starte Winpdb.
2. Setze das Fehlerdiagnoseprogramm Passwort auf "test": Gehe zum Menü Datei → Passwort und setze das Passwort.

Jetzt werden wir ein Python-Test-Skript in FreeCAD Schritt-für-Schritt ablaufen lassen.

1. Starten Sie winpdb und setzen Sie ein Passwort (z.B. Test)
2. Erzeugen Sie eine Pythondatei mit folgendem Inhalt:

import rpdb2
rpdb2.start_embedded_debugger("test")
import FreeCAD
import Part
import Draft
print "hello"
print "hello"
import Draft
points=[FreeCAD.Vector(-3.0,-1.0,0.0),FreeCAD.Vector(-2.0,0.0,0.0)]
Draft.makeWire(points,closed=False,face=False,support=None)

1. Starte FreeCAD und lade die obige Datei in FreeCAD.
2. Drücke F6, um es auszuführen.
3. Jetzt wird FreeCAD nicht mehr reagieren, weil das Python Fehlerdiagnoseprogramm wartet.
4. Wechsle zur Windpdb GUI und klicke auf "Anhängen". Nach einigen Sekunden erscheint ein Eintrag "<Eingabe>", in dem du doppelt klicken musst.
5. Nun erscheint das aktuell ausgeführte Skript in der Winpdb.
6. Setze einen Bruch in der letzten Zeile und drücke F5.
7. Drücke nun F7, um in den Python Code von Draft.makeWire zu gelangen.

Voraussetzungen:

• Das ptvsd-Paket muss in einer Python 3-Installation außerhalb von FreeCAD installiert werden, und anschließend muss das Modul in FreeCADs Python-Bibliothek-Ordner kopiert werden.

# In a cmd window that has a path to you local Python 3:
pip install ptvsd
# Then if your Python is installed in C:\Users\<userid>\AppData\Local\Programs\Python\Python37
# and your FreeCAD is installed in C:\freecad\bin
xcopy "C:\Users\<userid>\AppData\Local\Programs\Python\Python37\Lib\site-packages\ptvsd" "C:\freecad\bin\Lib\site-packages\ptvsd"

pypi Seite

Visual Studio Code Dokumentation für die Fern Fehlerdiagnose

Schritte:

• Füge folgenden Code am Anfang deines Skripts hinzu

import ptvsd
print("Waiting for debugger attach")
# 5678 is the default attach port in the VS Code debug configurations
ptvsd.enable_attach(address=('localhost', 5678), redirect_output=True)
ptvsd.wait_for_attach()

• Eine Fehlerdiagnosekonfiguration in Visual Studio Code hinzufügen Fehlerdiagnose → Konfigurationen hinzufügen....
• Die Konfiguration sollte so aussehen:

    "configurations": [
        {
            "name": "Python: Attacher",
            "type": "python",
            "request": "attach",
            "port": 5678,
            "host": "localhost",
            "pathMappings": [
                {
                    "localRoot": "${workspaceFolder}",
                    "remoteRoot": "."
                }
            ]
        },

• Füge im VS-Code einen Haltepunkt hinzu, wo immer Du willst.
• Starte das Skript in FreeCAD. FreeCAD Freeze wartet auf den Anhang.
• In VS Code startest Du die Fehlerdiagnose durch Verwendung der erstellten Konfiguration. Du solltest Variablen im Fehlerdiagnosebereich sehen.
• Beim Setzen von Haltepunkten wird sich VS-Code darüber beschweren, die im VS-Code-Editor geöffnete .py-Datei nicht zu finden.
  • Ändere "remoteRoot": "." zu "remoteRoot": "<Verzeichnis der Datei>"
    • z.B. wenn sich die Python-Datei in /home/FC_myscripts/myscript.py befindet
    • wechsle zu "remoteRoot": "/home/FC_myscripts"
  • Wenn Du nur FreeCAD-Makros aus dem FreeCAD-Makro-Ordner folder überprüfst und dieser Ordner "C:/Users/<userid>/AppData/Roaming/FreeCAD/Macro" heißt, dann verwende:
    • "localRoot": "C:/Users/<userid>/AppData/Roaming/FreeCAD/Macro",
    • "remoteRoot": "C:/Users/<userid>/AppData/Roaming/FreeCAD/Macro"
• Wenn dein Makro ptvsd nicht findet, obwohl du es irgendwo installiert hast, stelle 'import ptvsd' folgendes voran

from sys import path
sys.path.append('/path/to/site-packages')

Dabei zeigt der Pfad auf das Verzeichnis, in dem ptvsd installiert wurde.

• Auf der linken unteren Seite des VSCode kannst Du das Python-Programm auswählen - es ist das Beste, die mit FreeCAD ausgelieferte Version zu verwenden.

In der Mac-Version ist es /Applications/FreeCAD.App/Contents/Resources/bin/python

Du kannst es auf deinem System lokalisieren durch Eingabe von

import sys
print(sys.executable)

in die FreeCAD-Python-Konsole.

• Extract AppImage.

> ./your location/FreeCAD_xxx.AppImage --appimage-extract
> cd squashfs-root/

• The sqashfs-root location is where the debugger later on is hooked up to.

• Make sure you can start a FreeCAD session from within the squashfs-root location.

squashfs-root> ./usr/bin/freecadcmd

• Should start up a FreeCAD commandline session.

• Install LiClipse.
  • Comes ready with pydev and has installers for all platforms.
  • For linux it is just to extract (to any location) and run.

• Configure liclipse for debugging.
  • Right-click pydev icon (upper right corner) and choose customize.
    • Activate "PyDev Debug" (through checkbox, or it might be needed to go to tab "Action Set Availability" and activate there first).
    • In the pydev menu you can now choose "start debug server".
  • Use menu window/open perspective/other > debug.
    • Right-click debug icon (upper right corner) and choose customize.
    • Checking "Debug" brings the debugging navigation tools to the toolbar.
  • Open preferences through menu window/preferences.
    • In PyDev/Interpreters add "new Interpreter by browsing".
    • The added interpreter should be: your loc/squashfs-root/usr/bin/python.
    • If you are only using this for fc, you can add AddOn workbench folders as well, or do that in a pydev-project later on.

• Find path to pydevd.py in your liclipse installation.
  • Something along the lines of: your location/liclipse/plugins/org.python.pydev.xx/pysrc.
• Create a regular pydev-project in liclipse.
  • Import external sources, for example a macro that you want to debug, or an external workbench.
  • In that macro (or workbench .py file) add the code lines:

import sys; sys.path.append("path ending with /pysrc")
import pydevd; pydevd.settrace()

• This is where the execution will halt when the macro is run.

• Start the liclipse debug server (menu pydev).

• Start FreeCAD.

squashfs-root> ./usr/bin/freecad

• Run the macro (or any other file with a pydevd.settrace() trigger) from within freecad, as you would normally do.

• Happy debugging.

• The use of LiClipse for remote debugging, and the steps described here related to liclipse, should work on any platform. The parts related to AppImage is for linux only.